home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / graphic / chiaro10.zip / GIFCHECK.DOC < prev    next >
Text File  |  1993-03-12  |  48KB  |  1,103 lines
  1. GIFCHECK 1.11 DOCUMENTATION
  2. ===========================
  3. James W. Birdsall
  4. 03/19/93
  5.  
  6.  
  7. 0. CONTENTS
  8. -----------
  9.    0.      CONTENTS
  10.    1.      INTRODUCTION
  11.     1.1     Quick Reference
  12.     1.2     Copyright, License, and Warranty Disclaimer
  13.    2.      USAGE
  14.     2.1     Targets
  15.      2.1.1   Wildcards
  16.     2.2     Options
  17.      2.2.1   Output redirection options
  18.      2.2.2   Output format options
  19.      2.2.3   Processing options
  20.      2.2.4   Diagnostic options
  21.      2.2.5   -# Version
  22.      2.2.6   -? Help
  23.    3.      OUTPUT
  24.     3.1     File Header
  25.     3.2     Image
  26.     3.3     Extension Blocks
  27.      3.3.1   Generic extensions
  28.      3.3.2   Graphic Control Extension
  29.      3.3.3   Plain Text Extension
  30.      3.3.4   Comment Extension
  31.      3.3.5   Application Extension
  32.     3.4     Terminator
  33.    4.      DIAGNOSTIC MESSAGES
  34.     4.1     Anomalies
  35.     4.2     Violations
  36.     4.3     Fascinatings
  37.     4.4     Nitpicks
  38.     4.5     Miscellaneous
  39.    5.      THE END
  40.  
  41.  
  42. 1. INTRODUCTION
  43. ---------------
  44.  
  45.    GIFCHECK is a program of the Chiaro suite. It performs a complete
  46. analysis and verification of GIF-format images and displays the
  47. information it finds. It can also be used in batch files to determine
  48. whether GIF files need to be passed through the GIFSTRIP program to
  49. remove excess characters.
  50.  
  51.  1.1 Quick Reference
  52.  -------------------
  53.  
  54.     This is a quick summary of the usage and options of GIFCHECK.
  55. Invoking GIFCHECK with the option "-?" will produce a similar summary.
  56. Complete explanations may be found in section 2.
  57.  
  58.    usage: gifcheck [options] target [target ...]
  59.       target       filename, filename with wildcards, or path. Wildcards
  60.                     are *, ?, and ranges or groups specified in []. A
  61.                     range or group may be complemented with ^ or !.
  62.  
  63.       -b           BATCH: suppresses all console output. Should be first
  64.                     on the line. Returns ERRORLEVEL 0 if OK, 1 if a
  65.                     non-GIF file was found, 2 if unexpected EOF in a GIF
  66.                     file, 3 on other error, 4 if the GIF is OK but needs
  67.                     to be stripped, and 5 if the. GIF is OK but needs to
  68.                     be stripped with the -m option.
  69.       -r           Sends error messages to stderr instead of stdout.
  70.       -p           Turn off paging of output (paging always off when
  71.                     stdout is redirected or -b BATCH is in effect).
  72.  
  73.       -v           VERBOSE: turns on verbose output.
  74.       -h           HEX DUMP: switches from ASCII to HEX dump for certain
  75.                     blocks.
  76.       -c           COLOR DUMP: dumps raw RGB values from all colormaps.
  77.  
  78.       -l           Disables checking for leading junk characters (from a
  79.                     Mac, for example).
  80.       -f           FAST: disables decompression. Only block formatting
  81.                     is checked.
  82.  
  83.       -dn          SET DISPLAY WARNING LEVEL:
  84.                     0   displays anomalies and violations
  85.                     1   (default) displays anomalies, violations, and
  86.                          fascinatings
  87.                     2   displays anomalies, violations, fascinatings,
  88.                          and nitpicks
  89.       -en          SET EXIT WARNING LEVEL:
  90.                     0   exits on anomalies only
  91.                     1   (default) exits on anomalies and violations
  92.                     2   exits on anomalies, violations, and fascinatings
  93.  
  94.       -#           VERSION: Prints version information on internal
  95.                     modules, then exits.
  96.  
  97.    GIFCHECK automatically reads a list of targets from stdin if stdin is
  98. redirected. Targets must be separated by newlines, and are
  99. wildcard-expanded in the same way as command-line targets. Note that
  100. command-line targets are ignored if stdin is redirected; if stdin is not
  101. redirected, there must be at least one target on the command line.
  102.  
  103.    Options are case-insensitive, and may not be combined.
  104.  
  105.  1.2 Copyright, License, and Warranty Disclaimer
  106.  -----------------------------------------------
  107.  
  108.    The Graphics Interchange Format(c) is the Copyright property of
  109. CompuServe Incorporated. GIF(sm) is a Service Mark property of
  110. CompuServe Incorporated.
  111.  
  112.    GIFCHECK is not in the public domain. All the files are copyright
  113. 1993 by James W. Birdsall, all rights reserved.
  114.  
  115.    The following license applies to the entire Chiaro suite, which is
  116. made up of all the files listed in the file MANIFEST. Permission is
  117. granted to do the following:
  118.  
  119.         You may freely redistribute this archive, so long as it contains
  120.         all the files listed in the file MANIFEST, intact and
  121.         unmodified.
  122.  
  123.         You may use the programs contained in this archive for a period
  124.         of 30 days for evaluation purposes.
  125.  
  126.    Payment of the $10 shareware fee (which covers all the programs in
  127. the Chiaro suite) licenses you to use the Chiaro suite beyond the
  128. evaluation period. This license-to-use specifically includes use by
  129. bulletin board systems and other commercial or private information
  130. services.
  131.  
  132.    Registered users will also receive update notices and bug reports,
  133. and are entitled to use future versions without further payment.
  134.  
  135.    The contents of the distribution archive, and all other related
  136. files, information, and services are provided "as is" and without
  137. warranty. To the extent permitted by applicable law, the author
  138. disclaims all warranties, express or implied, including but not limited
  139. to, any implied warranty of merchantability or fitness for a particular
  140. purpose. While effort has been made to ensure that the files,
  141. information, and services are accurate and correct, the author shall not
  142. be liable for damages arising out of the use of or inability to use this
  143. product, including but not limited to, loss of profit, data, or use of
  144. this software, or special, incidental, or consequential damages or other
  145. similar claims, even if the author has been specifically advised of the
  146. possibility of such damages. Some states do not allow the exclusion of
  147. incidental or consequential damages, so the foregoing limitation may not
  148. apply to you.
  149.  
  150.    Information on contacting the author is provided at the end of this
  151. file.
  152.  
  153.  
  154. 2. USAGE
  155. --------
  156.  
  157.    GIFCHECK may be called with zero or more options interspersed with
  158. zero or more targets. All options are scanned before any file searching
  159. is done, so order of options and targets is unimportant. If the standard
  160. input is not redirected, at least one target must be specified on the
  161. command line. If the standard input is redirected (is not the keyboard),
  162. GIFCHECK will detect this and will attempt to read a list of targets,
  163. separated with newlines, from the standard input. Targets on the command
  164. line will be ignored, but options on the command line will be used. This
  165. feature is for use with the "front end" option of CHILS.
  166.  
  167.    GIFCHECK requires 150,000 bytes of free conventional memory to run.
  168.  
  169.  2.1 Targets
  170.  -----------
  171.  
  172.    A target can consist of a filename (optionally with path), a path, or
  173. a filename with wildcards (again, optionally with path). In the case of
  174. a filename, that file is checked. In the case of a path, all files in
  175. the specified directory are checked. In the case of a filename with
  176. wildcards, all files in the appropriate directory (the current directory
  177. if no path is given) matching the wildcards are checked.
  178.  
  179.    If a file that is checked is a GIF format file, it is processed. If
  180. it is not, it is not processed.
  181.  
  182.   2.1.1 Wildcards
  183.   ---------------
  184.  
  185.    Wildcards are much closer to the UNIX standard than MS-DOS. The
  186. characters * and ? retain their ordinary meanings but matching is much
  187. more intelligent. For example, *A.GIF will match LENNA.GIF but not
  188. CHESS.GIF, whereas under ordinary MS-DOS wildcards, *A.GIF would match
  189. both. Further, groups and ranges of characters may be specified in
  190. brackets []. For example, PIC0[1-5].GIF will match any filename starting
  191. with "PIC0", then containing any one of the characters "1", "2", "3",
  192. "4", or "5", and ending with ".GIF". PIC0[1-5A-F].GIF will match the
  193. names